home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / scope / 201-220 / scopedisk217 / mplay / mplay.doc < prev    next >
Encoding:
Text File  |  1995-03-20  |  7.2 KB  |  267 lines
  1.  
  2. MODULE-PLAYER v4.1 - (c)1990-1991 by Harald Schneider
  3. =====================================================
  4.  
  5.  
  6. Note at the Beginning:
  7. ----------------------
  8.  
  9. MPlay is PUBLIC DOMAIN !
  10.  
  11. That means you can feel totally free in  duplicating and distributing this
  12. nice PRG for non-commercial purposes.
  13.  
  14. It is NOT ALLOWED to change its code or the Author's Notice.
  15.  
  16. MPlay should be spread with this manual and its history-file, only !
  17.  
  18.  
  19.  
  20. A Short Description:
  21. --------------------
  22.  
  23. With  MPlay you'll get a useful tool for playing the saved datas (MODULES)
  24. of the following soundsystems:
  25.  
  26.             - BP-Soundmon       2.0
  27.             - Delta-Music      2.x
  28.             - Future-Composer  x.x
  29.             - Mark-II       x.x
  30.             - Noisetracker     x.x
  31.             - Oktalyzer       x.x (4-8 channel)
  32.             - Protracker       x.x
  33.             - SoundFx       x.x
  34.             - Soundtracker       x.x
  35.             - Star-Trekker     1.2 (  4 channel)
  36.             - TFMX-Workstation x.x
  37. It can also replay
  38.             - IFF-8SVX-SAMPLES
  39.  
  40. up to a max. lenght of 131070 bytes.
  41.  
  42. All MODULES might be crunched with PowerPacker or STC (the most efficient 
  43. data-cruncher available, yet !).
  44.  
  45.  
  46.  
  47.  
  48. How 2 use:
  49. ----------
  50.  
  51. There are (I guess) 3 ways of how to use MPlay:
  52.  
  53.  
  54.  1) Double-clicking the mega-cool Icon on your workbench-screen.
  55.  
  56.     MPlay will prompt you a FileSelect-Box, where you can select all MODULES
  57.     by using the mouse.  Make  yourself sure, that  'req.library'  is in the
  58.     libs-directory of your bootdisk.
  59.  
  60.     Via TOOL-TYPES you can define the startup-directory of the filerequester.
  61.     If there is no TOOL-TYPE defined, the requester will automatically prompt
  62.     you the directory ':MODULES/'. You also can set  MPlay's options the same
  63.     way:
  64.  
  65.     e.g. writing
  66.             -k :df1:modules/mod.freibier
  67.  
  68.     into the TOOL-TYPES-field, will force MPlay to use 'df1:modules/' as the
  69.     filerequester's default-directory. 'mod.freibier' will be preset as file
  70.     name (just press the OK-Gadget to load it up !).  Furthermore MPlay will
  71.     use option [-k] ...
  72.  
  73.     To learn more about MPlay's options, continue reading this file.
  74.  
  75.     For changing the  TOOL-TYPE of MPlay,  just select the INFO-command from
  76.     your workbench-menu (or consult your user's manual - hope you'll find it
  77.     ...).
  78.  
  79.  
  80.  2) Starting MPlay from your CLI:
  81.  
  82.     The syntax of MPlay, when being used from CLI is
  83.  
  84.         MPlay [OPTIONS] <MODULE>
  85.  
  86.     Some Xamples, now:
  87.  
  88.  
  89.   2.1) MPlay
  90.  
  91.        Typing  MPlay without any parameters will give you a  short help-text
  92.        and the support-list of the current version.
  93.  
  94.  
  95.   2.2) MPlay mod.batman
  96.  
  97.        This will load up the MODULE 'mod.batman'.
  98.        If the MODULE's name isn't found in the current directory, MPlay will
  99.        search the directory ':MODULES/'.
  100.  
  101.        So you'll only have to type
  102.  
  103.             MPlay mod.batman
  104.        instead of
  105.             MPlay :MODULES/mod.batman
  106.  
  107.        Filenames, which include blanks MUST be set in quotes:
  108.  
  109.        e.g.         MPlay "mod.batman part 2"
  110.  
  111.  
  112.        All output will appear on your CLI-window.
  113.  
  114.  
  115.   2.3) MPlay -f  pathname/modulename  ( FileSelect-Box )
  116.  
  117.        Here MPlay prompts you the FileSelect-Box, showing you  the directory
  118.        ':MODULES'. If you don't like that, you can specify another dir-name:
  119.  
  120.        e.g.
  121.          MPlay -f dh0:sound/soundtracker/modules/
  122.  
  123.        The directory 'dh0:sound/soundtracker/modules/' will automatically be
  124.        loaded to the FileSelect-Box.
  125.  
  126.        Option [-f] includes option [-r].
  127.  
  128.  
  129.   2.4) MPlay -r modulename  ( Request-Window )
  130.  
  131.        Using this option, will redirect all output to a special Request-Win-
  132.        dow. The window can be flushed away by clicking its gadget.
  133.  
  134.  
  135.   2.5) MPlay -k modulename  ( Keyboard-Control )
  136.  
  137.        After having used this option, you will be asked to press ESC instead
  138.        of using the mouse to abort playing.
  139.  
  140.  
  141.   2.6) MPlay -d modulename  ( Detach immediately from CLI )
  142.  
  143.        Using switch [-d] forces MPlay to detach IMMEDIATELY from CLI.
  144.  
  145.        I made  detach()  optionally to keep MPlay compatible with such PRGs
  146.        like SID (for more info on this topic, just read point no. 3).
  147.  
  148.  
  149.   2.7) MPlay -l modulename  ( Load & Detach )
  150.  
  151.        With that option, MPlay  detaches from CLI  AFTER  it has loaded the
  152.        the MODULE.
  153.  
  154.        You generally should use this switch,  when including  MPlay  into a
  155.        startup-sequence or a script-file. MPlay will do it's job BEFORE the
  156.        next command is processed and will keep  Amiga-DOS  from raping your
  157.        disk-drive. You'll *NEVER* need a WAIT after MPlay's CALL.
  158.  
  159.        This feature allows MPlay being used as a Backround-Music-Player for
  160.        Dia-Shows, Catalog-Disks, etc. Just try !
  161.  
  162.  
  163.   2.8) MPlay -q modulename  ( Quiet-Mode )
  164.  
  165.        Switch [-q] forces MPlay to supress its output  (Quiet-Mode). But be
  166.        aware, that you won't see any ERROR-Messages, when using this mode.
  167.  
  168.        Switches [-d] or [-l] automatically avoid ALL output,  so you don't
  169.        need option [-q] here. Option [-q] is for CLI-usage, only.
  170.  
  171.        If you want MPlay to detach  and  reporting it's output to the user,
  172.        you'll have to use option [-r].
  173.  
  174.  
  175.   2.9) MPlay -c modulename  ( CIAA-Timer-Interrupt )
  176.  
  177.        Here MPlay links itself to the CIAA-Timer-Interrupt.  This option is
  178.        very handy, when the Vertical-Blank-Interrupt is used intensively by
  179.        other PRGs. So MPlay won't slow down your machine, too.
  180.  
  181.  
  182.  3) Using MPlay with other utilities:
  183.  
  184.     With 'other' I mean such tools like SHELLs, 'SID' or 'MyMenu'.
  185.  
  186.     Here you can use combinations of ALL options.  E.g. when working with a
  187.     SHELL, you can do this:
  188.  
  189.         ALIAS     mplay    "c:MPlay -fkdc df1:modules/"
  190.  
  191.     Typing 'mplay' on your Shell will popup the FileSelect-Box, showing you
  192.     the content of  'df1:modules/'  and  all output  will be  redirected to
  193.     MPlay's Request-Window.  You can still continue working,  coz MPlay has
  194.     detached from your Shell. While playing, MPlay uses the  CIAA-Interrupt
  195.     and NOT the Vertical-Blank-Interrupt.  You can quit  by  hammering (!?)
  196.     the ESC-key and NOT by pressing the left mousebutton.
  197.  
  198.     When using  MPlay  with SID, you  MUST NOT  use switches  [-d] or [-l].
  199.     Otherwise SID will not be able to pass it's arguments to MPlay.
  200.  
  201.  
  202.  
  203.  
  204. KNOWN BUGS
  205. ----------
  206.  
  207.  1) Option [-c] works correctly with PAL-Machines, only.
  208.  
  209.  2) When running MPlay with a beta-release of  OS2  and clicking the close-
  210.     -gadget of the report-window, the screen will freeze :-( .
  211.  
  212.     I detected this bug when using KICK v37.175.  I don't know if this bug
  213.     is still resident in later versions.
  214.  
  215.  3) Oktalyzer-Replay() still contains a bug, which causes some scratching
  216.     sounds. This bug depends on which song you are playing and can be found
  217.     in the original 'ok_play.o', too.
  218.  
  219.     Trying to fix this ASAP ...   :)
  220.  
  221.  
  222.  
  223. Note at the End
  224. ---------------
  225.  
  226. If you find any other bug (there won't be any ยงยง$"%&# !) in the latest ver-
  227. sion of MPlay or if you have suggestions of improvement, then write to:
  228.  
  229.  
  230.  
  231.             HARALD SCHNEIDER
  232.             Am Haeusel 163
  233.  
  234.             D-6780 Pirmasens
  235.  
  236.             Federal Republic Of Germany
  237.  
  238.  
  239.  
  240.  
  241. Ooooops !
  242.  
  243. Before I quit this file I want to thank  ALL those people, who created all
  244. these replay-routines hacked together in this product.
  245.  
  246. I also wanna thank the following people:
  247.  
  248.  
  249.     - Amiga Freelancers        - for sending me 'Protracker v1.1b'
  250.  
  251.     - Bruce Dawson & Colin Fox  - for their great 'req.library'
  252.  
  253.     - Nico Francois         - for 'pp_decrunch.s'
  254.  
  255.     - OTT-Design            - for sending me their 'STC' (HI Tero !)
  256.  
  257.  
  258. Bye,bye !
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266. EOF :)
  267.